org.eclipse.vtp.framework.common.services
Class ScriptableSessionContext

java.lang.Object
  org.eclipse.vtp.framework.common.services.ScriptableSessionContext

All Implemented Interfaces:

IScriptable

public class ScriptableSessionContext
extends java.lang.Object
implements IScriptable

An IScriptable implementation that makes the ISessionContext instance available as a scripting object.

This service will make available a "Session" object to all scripts in its scope. The variable supports the following properties:

• id: a string containing the session ID
• attributes: an object containing the session attributes

The attributes object listed above will have a property for each session attribute defined in the session context. New attributes may be added by assigning to non-existent properties of the object. The attributes object will not have an implicit value.

The "Session" scripting object uses the session ID as the implicit value, thus it can be compared to other string objects.

Author:

Lonnie Pryor

See Also:

ISessionContext

Constructor Summary

ScriptableSessionContext(ISessionContext context)
Creates a new ScriptableSessionContext.

Method Summary

boolean	clearEntry(java.lang.String name)
boolean	clearItem(int index)
java.lang.Object	getEntry(java.lang.String name)
java.lang.String[]	getFunctionNames()
java.lang.Object	getItem(int index)
java.lang.String	getName()
boolean	hasEntry(java.lang.String name)
boolean	hasItem(int index)
boolean	hasValue()
java.lang.Object	invokeFunction(java.lang.String name, java.lang.Object[] arguments)
boolean	setEntry(java.lang.String name, java.lang.Object value)
boolean	setItem(int index, java.lang.Object value)
java.lang.Object	toValue()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScriptableSessionContext

public ScriptableSessionContext(ISessionContext context)

Creates a new ScriptableSessionContext.

Parameters:

context - The context to provide scripting services for.

Method Detail

getName

public final java.lang.String getName()

Specified by:

getName in interface IScriptable

hasValue

public boolean hasValue()

Specified by:

hasValue in interface IScriptable

toValue

public java.lang.Object toValue()

Specified by:

toValue in interface IScriptable

getFunctionNames

public final java.lang.String[] getFunctionNames()

Specified by:

getFunctionNames in interface IScriptable

invokeFunction

public final java.lang.Object invokeFunction(java.lang.String name,
                                             java.lang.Object[] arguments)

Specified by:

invokeFunction in interface IScriptable

hasItem

public final boolean hasItem(int index)

Specified by:

hasItem in interface IScriptable

hasEntry

public final boolean hasEntry(java.lang.String name)

Specified by:

hasEntry in interface IScriptable

getItem

public final java.lang.Object getItem(int index)

Specified by:

getItem in interface IScriptable

getEntry

public final java.lang.Object getEntry(java.lang.String name)

Specified by:

getEntry in interface IScriptable

setItem

public final boolean setItem(int index,
                             java.lang.Object value)

Specified by:

setItem in interface IScriptable

setEntry

public final boolean setEntry(java.lang.String name,
                              java.lang.Object value)

Specified by:

setEntry in interface IScriptable

clearItem

public final boolean clearItem(int index)

Specified by:

clearItem in interface IScriptable

clearEntry

public final boolean clearEntry(java.lang.String name)

Specified by:

clearEntry in interface IScriptable